﻿#region Header
// ------------------------ Licence / Copyright ------------------------
// 
// ScrumTable for Scrum Meeting Support
// Copyright © HSR - Hochschule für Technik Rapperswil
// All Rights Reserved
// 
// Author:
//  Michael Gfeller Silvan Gehrig Patrick Boos
// 
// ---------------------------------------------------------------------
#endregion

#region Usings

using System;

using ScrumTable.Common.Collections;
using ScrumTable.Common.Monitoring;

#endregion

namespace ScrumTable.DL.Data.Generic.Services
{
    /// <summary>
    /// This class is used to load data into the current data driver.
    /// </summary>
    public interface IDataLoader
    {
        #region Properties
        //--------------------------------------------------------------------
        // Properties
        //--------------------------------------------------------------------

        #endregion

        #region Methods
        //--------------------------------------------------------------------
        // Methods
        //--------------------------------------------------------------------

        /// <summary>
        /// Loads the data which is required to connect to the back end tfs
        /// system.
        /// </summary>
        /// <param name="dataContext">Specifies the data context which contains the underlying data driver root object.</param>
        /// <param name="callback">Specifies the callback used to retrieve the connection state. The callback value is of type DataResult.</param>
        void LoadConnectionData(GenericDataContextBase dataContext, AsyncCallback callback);

        /// <summary>
        /// Loads the data blow the given key chain.
        /// </summary>
        /// <param name="dataContext">Specifies the data context which contains the underlying data driver root object.</param>
        /// <param name="idChain">The data below the given id should be imported.</param>
        /// <param name="importMonitor">Specifies the monitor which observes the import.</param>
        void LoadInitialData(GenericDataContextBase dataContext, ValueChain<string> idChain, IDataImportMonitor importMonitor);

        #endregion

    }
}